home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / games / addons / brespy11.arj / BRESPY.DOC next >
Text File  |  1994-01-14  |  15KB  |  337 lines
  1.                           Barren Realms Elite -- Spy
  2.                                     v1.1
  3.                           Copyright 1994 Steve Meier
  4.                           
  5. What is BRESPY:
  6. ~~~~~~~~~~~~~~~
  7.     BRESPY is a program for Sysops that generates lists or bulletins for 
  8.     Barren Realms Elite.  This includes ANSI and TEXT files for use in the 
  9.     game itself or for viewing online from another area of the BBS.  You 
  10.     can even compress them and let the users download them on a daily 
  11.     basis.  Basically this program breaks the empires down and puts the 
  12.     data in a usable format so you and your users can make the best 
  13.     decisions on who to attack or how to build your empire.  All the 
  14.     empires are broken down into percentages on Regions and NetWorth.  At 
  15.     the end of the list is a summary of the averages for that system.
  16.     
  17.                          
  18. Software Requirements:
  19. ~~~~~~~~~~~~~~~~~~~~~~
  20.     BRESPY will work with Barren Realms Elite, v0.950 and up.
  21.  
  22.  
  23. Warranty:
  24. ~~~~~~~~~
  25.     I make no guarantees with this software.  While it works fine on my
  26.     system, I can't promise you'll have the same results.  Use this 
  27.     software at your own risk.  However, if you do experience difficulties 
  28.     with the BRESPY, please let me know via the FidoNet address provided 
  29.     below.  Or contact me in the SRGAMES echo.
  30.  
  31.  
  32. Distribution:
  33. ~~~~~~~~~~~~~
  34.     This software is FREE to use.  Please feel free to copy it and pass it
  35.     along to a friend.  All I ask is that you keep all the original files
  36.     together in whatever archive package you like best and that you not 
  37.     alter any of the files in anyway.
  38.  
  39.  
  40. Instructions:
  41. ~~~~~~~~~~~~~
  42.     Setting up the software is very easy.  Just place the BRESPY.EXE file
  43.     in your main BRE dir and type BRESPY.  It's best to run this in a BATCH
  44.     file in your nightly events or right after you process incoming
  45.     packets.  Here are some examples:
  46.  
  47.     In a nightly event you might have:
  48.  
  49.     BRE RECON
  50.     BRE PLANETARY
  51.     BRSCORES
  52.     BRESPY
  53.  
  54.     In a batch file logging into the game you might have:
  55.  
  56.     BRE INBOUND
  57.     BRESPY
  58.  
  59.     This program has the ability to replace your "BULLETIN.LST" file in the
  60.     BRE\GAME directory.  If you have important information in your
  61.     BULLETIN.LST file, I suggest you read the rest of the documentation
  62.     before proceeding.
  63.  
  64.     There are four options you can add to the RESOURCE.DAT file.  They are 
  65.     as follows:
  66.  
  67.     brespybulletin
  68.     brespyrealname
  69.     brespyansi
  70.     brespytext
  71.  
  72.     These are case-insensitive, meaning you can enter them in all caps or 
  73.     mix and match.  It will work either way.  Same with the true and false 
  74.     entries along with the path names.
  75.  
  76.  
  77. BreSpyBulletin:  Booleen            DEFAULT:  FALSE
  78. ~~~~~~~~~~~~~~~
  79.     This options determines if you want a BULLETIN.LST format for your
  80.     file.  If you enable this, BRESPY will add ^ANS or ^TXT and the ^END in
  81.     the file.  It will also add text and ANSI screen clear codes.  This
  82.     enables you to build online bulletins for your users to look at in the
  83.     BULLETINS section of the Main Menu of BRE.  This is not intended to be 
  84.     used on the I-P menu or the users will see ^ANS and ^TXT.
  85.  
  86.     If you disable this option, it will create a file with one system right
  87.     after the other.  This is useful for adding to the external score files
  88.     in the other menus.  (See BRE's documentation on how to do this).  You
  89.     can also make this available for users to download or put it in the
  90.     Text files section of your BBS.
  91.     
  92.     Valid syntax for this option is only true or false.
  93.  
  94.  
  95. BreSpyRealName:  Booleen            DEFAULT:  FALSE
  96. ~~~~~~~~~~~~~~~
  97.     The option will give you the name of the BBS instead of TXT### and 
  98.     ANS###.  Your users will have alot more typing to do so you may prefer 
  99.     the shortened method.  This option only works if BRESPYBULLETIN is set 
  100.     to true.  The BBS names will show up in ALL CAPS, since that is the
  101.     requirement of BRE for it to display the bulletins.
  102.  
  103.     Valid syntax for this option is only true or false.
  104.     
  105.  
  106. BreSpyANSI:  Booleen/String         DEFAULT:  TRUE/BRESPY.ANS 
  107. ~~~~~~~~~~~
  108.     This option determines if you want an ANSI file generated.  It will
  109.     also take a file drive:\path\filename.ext too.  If you set it to true
  110.     or false, it will enable or disable ANSI file generation.  If you put a
  111.     path and filename in there you have to use quotes like this:
  112.  
  113.     brespyansi    "c:\bre\game\bulletin.lst"
  114.  
  115.     This automatically ENABLES ANSI files when you define a filename like 
  116.     this.  The DEFAULT for this option is TRUE and the file it creates is 
  117.     BRESPY.ANS.  If you want to turn this option OFF, you have to set it to 
  118.     FALSE in the RESOURCE.DAT file.  BRESPY.ANS is generated in the 
  119.     directory BRESPY is run from.  If you run this option with 
  120.     BRESPYBULLETIN set to TRUE, ANS### will show up in the bulletin.  This 
  121.     is short for ANSI.  The best thing to do is have the users go to the 
  122.     I-P Menu and get a listing from the I-P Mail option.  They can print 
  123.     out a list of all the boards by name and number.  I chose this method 
  124.     so the players don't have to type out the  W H O L E  B B S  N A M E. 
  125.     If I were attacking The Grand Illusion, I sure wouldn't want to type 
  126.     that out all the time.
  127.  
  128.     Valid syntax for this option is true or false or any VALID PATH.
  129.  
  130.  
  131. BreSpyTEXT:  Booleen/String         DEFAULT:  FALSE/BRESPY.TXT
  132. ~~~~~~~~~~~
  133.     This option works exactly the same way as BRESPYANSI, except it
  134.     determines if the TEXT files are generated.  This will also take any
  135.     VALID PATH.  The default for this option is OFF, and it generates is
  136.     BRESPY.TXT.  It also resides in the directory BRESPY was run from.
  137.     If you run this option with BRESPYBULLETIN set to TRUE, TXT### will 
  138.     show up in the bulletin.  See BRESPYANSI for why I chose this method.
  139.  
  140.     NOTICE:  You can name the ANSI file and the TEXT file the same!  If you
  141.     do, BRESPY will append the TEXT information to the end of the ANSI
  142.     file.  This is nice if you want to generate ANSI and TEXT files for
  143.     your bulletin menu in BRE.  Here's how to do it:
  144.  
  145.     brespybulletin          true
  146.     brespyansi              "game\bulletin.lst"
  147.     brespytext              "game\bulletin.lst"
  148.  
  149.     Valid syntax for this option is true or false or any VALID PATH.
  150.  
  151.  
  152. Examples:
  153. ~~~~~~~~~
  154.     brespybulletin          false   \
  155.     brespyansi              false    > This creates only BRESPY.TXT files
  156.     brespytext              true    /  for online viewing.
  157.  
  158.  
  159.     brespybulletin          true  <--  This creates BRESPY.ANS, but
  160.                                        puts it in the main BRE dir.
  161.  
  162.  
  163.     brespybulletin          true
  164.     brespyansi              "c:\games\bre\game\bulletin.lst" <-- This makes
  165.                                                                  ANSI
  166.                                                                  bulletins
  167.                                                                  for online
  168.                                                                  viewing
  169.                                                                  from the
  170.                                                                  BULLETINS
  171.                                                                  menu.
  172.  
  173.     Just remember, if you enable BRESPYBULLETIN you will get the chars for
  174.     BRE to display the file with it's BULLETIN menu.
  175.  
  176.  
  177. Checking the Bulletins:
  178. ~~~~~~~~~~~~~~~~~~~~~~~
  179.     Once you have setup the program and ran through it, log into the game 
  180.     and go to the BULLETINS.  You will see a list of new bulletins generated 
  181.     by BRESPY.  They will be in the following format:
  182.  
  183.     ANS1
  184.     ANS2
  185.     ANS3
  186.     .
  187.     .
  188.     .
  189.     ANS255
  190.  
  191.     There will only be bulletins created for nodes in the BRNODES.DAT file.
  192.     The Number is the node of the system.  
  193.    
  194.  
  195. How to read the Data:
  196. ~~~~~~~~~~~~~~~~~~~~~
  197.     Empires are broken down into individual percentages.  You get a
  198.     percentage for Regions and a percentage for NetWorth.  You also get an
  199.     AVERAGE percentage out of 100%.  This tells you what each player should
  200.     have if they are pulling their weight for the PLANET as a WHOLE.  If
  201.     there are 10 players, then each player should have about 10% of the
  202.     Regions and 10% of the NetWorth.  Why? Simple...  When a Gooie Kablooie
  203.     hits, every player gets hit evenly.  If the empires are way out of the
  204.     percentages, the BIG EMPIRES get hit harder and the SMALLER EMPIRES
  205.     hardly lose anything.  This is also true for ALL board attacks.  When
  206.     making an individual attack, you can pick out the targets on your ENEMY
  207.     PLANET(S) and find the Empire with the Higher percentage of Regions and
  208.     a Lower percentage of NetWorth.  This tells you that the Empire can't
  209.     defend it's regions. This makes them an EASY TARGET.  You can even look
  210.     at your own empire and see how you rank with the other players on your 
  211.     system.
  212.  
  213.  
  214. Sample Output:
  215. ~~~~~~~~~~~~~~ 
  216. ╒═[ Azure Dreams #2 ]════════════[ Sierra Vista, AZ ]════════════[ 11/29/93 ]═╕
  217. │  #  Empire Name                    Regions    (%)  NetWorth    (%)    Score │
  218. ╞═════════════════════════════════════════════════════════════════════════════╡
  219. │ <A> Pestulon                            15   0.9%        0k   0.8%       4k │
  220. │ <B> Exterminator                       376  21.4%       19k  21.2%       6k │
  221. │ <C> BudLand                            426  24.2%       21k  22.9%       4k │
  222. │ <D> Renland                            722  41.0%       38k  41.0%       6k │
  223. │ <E> Peracles Ostas                     220  12.5%       13k  14.2%       3k │
  224. ╞═════════════════════════════════════════════════════════════════════════════╡
  225. │  5  <-- Players               Avg:     351  20.0%       18k  20.0%       4k │
  226. │ Node Number: 309/53         Total:   1,759 100.0%       94k 100.0%      24k │
  227. ╘═════════════════════════════════════════════════════════════════════════════╛
  228.  
  229.     The date in the top right corner is the RECON date.  This tells you the
  230.     last time your Planet recon'ed with the one you're looking at.  If the
  231.     recon date is older than 2 days.  (By the time it reaches the 3rd day),
  232.     this date will FLASH RED...  (ANSI mode only) indicating the values
  233.     shown may not be valid.  This has also proved helpful in determining
  234.     how regular a system is getting its daily polls into the HUB...  You
  235.     should have no recon older than 2 days if all systems in the league
  236.     poll at least once a day.  The node number defaults to whatever ZONE
  237.     you're in.  Only NET and NODE are Shown, unless the entire #:###/### is
  238.     entered in the BRNODES.DAT file.
  239.  
  240.  
  241. Error Messages:
  242. ~~~~~~~~~~~~~~~
  243. Q:   "Error: Can't find BRNODES.DAT"
  244.  
  245. A:   Could not find the data file that has a list of all the nodes in it. 
  246.      Be sure it's on the drive or obtain another one from your League 
  247.      Coordinator.  Fatal error - A list will not be generated.
  248.  
  249. Q:  "Error: Can't find DATA\PLANET.BRE"
  250.  
  251. A:  Could not find the data file it needs to build the bulletin(s).  Check 
  252.     to be sure the file exists.  Also check the directory to be sure it 
  253.     exists. Fatal error - A list will not be generated.
  254.  
  255. Q:  "You disabled ANSI and TEXT output...  You must enable one!"
  256.  
  257. A:  You turned off both ANSI and TEXT output in the RESOURCE.DAT file. 
  258.     Enable one or both.  Silly error -- A list will not be generated.
  259.  
  260. Q:  "Error: Can't open <filename.ext>..."
  261.  
  262. A:  BRESPY can't open the file you defined in the RESOURCE.DAT file. Check 
  263.     to be sure you didn't specify an Invalid drive, directory or filename. 
  264.     Fatal error - A list will not be generated.
  265.  
  266. Q:  "You can't use the BreSpyRealName option for ANSI and TEXT when 
  267.     writting to a Bulletin -- Only the ANSI part was created by default."
  268.  
  269. A:  This means you can't enable ANSI and TEXT and write to a BULLETIN file 
  270.     using Real Names.  If you did, it would create an ANSI and a TEXT 
  271.     portion, but since the real name option is enabled you would have the 
  272.     same name for the TEXT bulletin as you would the ANSI bulletin and have 
  273.     no way to tell the difference between the two bulletin listings. In 
  274.     short the REAL NAME would appear TWICE in the file you designated as 
  275.     your BULLETIN file.  BRE would display both bulletins, one right after 
  276.     the other.  While not fatal, it might not produce the output you want 
  277.     it to.
  278.      
  279.  
  280. Quirks:
  281. ~~~~~~~
  282. Q:  How come the OLD RECON DATE doesn't flash when I'm in local mode?
  283.  
  284. A:  For some reason BRE doesn't handle the Flashing ANSI characters.  The
  285.     author knows about this, so it will work whenever he has the time to 
  286.     fix it.  Otherwise you get a solid blue background with red characters.
  287.     
  288. Q:  I added the filename to the ExternalScoresAnsi1 option in the 
  289.     resource.dat file, but I can't get it to display in the I-P Menu.
  290.  
  291. A:  You CANNOT add these bulletins to the I-P Menu since BRSCORES.EXE has 
  292.     been changed.  The author knows about this so it's up to him when it 
  293.     gets fixed.
  294.     
  295.  
  296. Program Info: 
  297. ~~~~~~~~~~~~~ 
  298.      This program was written using Borland's Turbo C (C).  Neither the 
  299.      source for it or the structures for BRE will be released.  Too much 
  300.      damage could come to the game if it fell in the wrong hands.  :-( You 
  301.      can always FREQ the latest version from my system as BRESPY.
  302.  
  303.  
  304. Special Thanks:
  305. ~~~~~~~~~~~~~~~
  306.     Thanks to Mehul Patel for writting such a GREAT game!
  307.     
  308.  
  309. Future Plans:
  310. ~~~~~~~~~~~~~
  311.     * An online help file you can read into the bulletins.
  312.     
  313.     * I'll try to keep it current with the new versions of BRE as they come 
  314.       out.
  315.  
  316.  
  317. Bug Reports:
  318. ~~~~~~~~~~~~
  319.     Hopefully there are none, but if you find one of these critters, I need
  320.     to know SPECIFICALLY what went wrong.  Not just -- "It doesn't display
  321.     right".
  322.     
  323.  
  324. Program History:
  325. ~~~~~~~~~~~~~~~~
  326. 01/14/94  Added some more information to the docs, error messages to the 
  327.           program and cleaned up the code.  Main addition was the RealName
  328.           problem is now reported, where before it would let you get by 
  329.           with it.
  330.           
  331. 01/08/94  Initial Release of BRESpy v1.0.
  332.  
  333.                                   Steve Meier
  334.                             The Grand Illusion BBS
  335.                                  (314)434-7260
  336.                              FidoNet -- 1:100/450
  337.